/*
 * DBeaver - Universal Database Manager
 * Copyright (C) 2010-2024 DBeaver Corp and others
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jkiss.dbeaver.model.struct;

import org.jkiss.code.NotNull;
import org.jkiss.code.Nullable;
import org.jkiss.dbeaver.DBException;
import org.jkiss.dbeaver.model.DBPDataKind;
import org.jkiss.dbeaver.model.runtime.DBRProgressMonitor;

import java.util.Collection;

/**
 * Provides extra type description, not covered by the database model
 */
public interface DBSTypeDescriptor {

    enum Kind {
        UNKNOWN,
        SIMPLE,
        INDEXABLE,
        COMPOSITE
    }

    /**
     * Returns underlying data type, if presented
     */
    @Nullable
    default DBSDataType getUnderlyingType() {
        return null;
    }

    /**
     * Returns data type name
     */
    @NotNull
    String getTypeName();

    @NotNull
    default Kind getKind() {
        return Kind.UNKNOWN;
    }

    @Nullable
    default DBPDataKind getDataKind() {
        return null;
    }

    /**
     * Returns the amount of indexable dimensions for indexable data type
     */
    default int getIndexableDimensions() {
        return 0;
    }

    /**
     * Returns type description for the result of the collection indexing
     * with the given amount of indexes or splicing specification
     */
    @Nullable
    default DBSTypeDescriptor getIndexableItemType(int depth, boolean[] slicingSpecOrNull) {
        return null;
    }

    /**
     * Returns collection for containing type descriptions for all the known named members of this type
     */
    @Nullable
    default Collection<CompositeMemberInfo> getCompositeMembers(@NotNull DBRProgressMonitor monitor) throws DBException {
        return null;
    }

    /**
     * Returns type description for the member having given name if such a member exists
     */
    @Nullable
    default DBSTypeDescriptor findCompositeMember(@NotNull DBRProgressMonitor monitor, String name) throws DBException {
        return null;
    }

    /**
     * Named member type information
     */
    record CompositeMemberInfo(
        @NotNull String name,
        @NotNull DBSTypeDescriptor type
    ) {
    }
}
